lteiot19.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef LTEIOT19_H
#define LTEIOT19_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"




#define LTEIOT19_CMD_SWITCH_DATA_TO_CMD                 "+++"
#define LTEIOT19_CMD_AT                                 "AT"
#define LTEIOT19_CMD_GET_MODEL_ID                       "AT+CGMM"
#define LTEIOT19_CMD_GET_SW_VERSION                     "AT+CGMR"
#define LTEIOT19_CMD_GET_SERIAL_NUM                     "AT+CGSN"
#define LTEIOT19_CMD_FACTORY_RESET                      "AT&F"
#define LTEIOT19_CMD_SW_RESET                           "ATZ"
#define LTEIOT19_CMD_SET_UE_FUNCTIONALITY               "AT+CFUN"
#define LTEIOT19_CMD_NETWORK_REGISTRATION               "AT+CEREG"
#define LTEIOT19_CMD_SIGNAL_QUALITY_REPORT              "AT+CSQ"
#define LTEIOT19_CMD_OPERATOR_SELECTION                 "AT+COPS"
#define LTEIOT19_CMD_SEND_SMS                           "AT+CMGS"
#define LTEIOT19_CMD_SELECT_SMS_FORMAT                  "AT+CMGF"
#define LTEIOT19_CMD_DEFINE_PDP_CONTEXT                 "AT+CGDCONT"
#define LTEIOT19_CMD_SHOW_PDP_ADDRESS                   "AT+CGPADDR"
#define LTEIOT19_CMD_TCP_OPEN_SOCKET                    "AT+KTCPCFG"
#define LTEIOT19_CMD_TCP_START_CONNECTION               "AT+KTCPCNX"
#define LTEIOT19_CMD_TCP_RECEIVE_DATA                   "AT+KTCPRCV"
#define LTEIOT19_CMD_TCP_SEND_DATA                      "AT+KTCPSND"
#define LTEIOT19_CMD_TCP_CLOSE_SOCKET                   "AT+KTCPCLOSE"
#define LTEIOT19_CMD_TCP_DELETE_SOCKET                  "AT+KTCPDEL"
#define LTEIOT19_CMD_UDP_OPEN_SOCKET                    "AT+KUDPCFG"
#define LTEIOT19_CMD_UDP_RECEIVE_DATA                   "AT+KUDPRCV"
#define LTEIOT19_CMD_UDP_SEND_DATA                      "AT+KUDPSND"
#define LTEIOT19_CMD_UDP_CLOSE_SOCKET                   "AT+KUDPCLOSE"
#define LTEIOT19_CMD_GNSS_START                         "AT+GNSSSTART"
#define LTEIOT19_CMD_GNSS_STOP                          "AT+GNSSSTOP"
#define LTEIOT19_CMD_GNSS_REPORT                        "AT+GNSSLOC"

#define LTEIOT19_RSP_OK                                 "OK"
#define LTEIOT19_RSP_ERROR                              "ERROR"
#define LTEIOT19_RSP_CONNECT                            "CONNECT"

#define LTEIOT19_MAX_RSP_TIME_DEFAULT                   2000ul
#define LTEIOT19_MAX_RSP_TIME_COPS                      120000ul
#define LTEIOT19_MAX_RSP_TIME_CFUN                      120000ul
#define LTEIOT19_MAX_RSP_TIME_CMGS                      30000ul
#define LTEIOT19_MAX_RSP_TIME_CGDCONT                   5000ul
#define LTEIOT19_MAX_RSP_TIME_TCP_START                 30000ul
#define LTEIOT19_MAX_RSP_TIME_TCP_DATA                  60000ul
#define LTEIOT19_MAX_RSP_TIME_TCP_CLOSE                 60000ul
#define LTEIOT19_MAX_RSP_TIME_UDP_DATA                  60000ul
#define LTEIOT19_MAX_RSP_TIME_UDP_CLOSE                 60000ul
#define LTEIOT19_MAX_RSP_TIME_URC                       30000ul

#define LTEIOT19_URC_TCP_SOCKET                         "+KTCPCFG: "
#define LTEIOT19_URC_TCP_DATA                           "+KTCP_DATA: "
#define LTEIOT19_URC_TCP_STATUS                         "+KTCP_IND: "
#define LTEIOT19_URC_UDP_SOCKET                         "+KUDPCFG: "
#define LTEIOT19_URC_UDP_DATA                           "+KUDP_DATA: "
#define LTEIOT19_URC_UDP_STATUS                         "+KUDP_IND: "
#define LTEIOT19_URC_NETWORK_REGISTERED                 "+CEREG: 2,1"
#define LTEIOT19_URC_SMS_FORMAT_PDU                     "+CMGF: 0"
#define LTEIOT19_URC_SMS_FORMAT_TXT                     "+CMGF: 1"

#define LTEIOT19_POWER_STATE_OFF                        0
#define LTEIOT19_POWER_STATE_ON                         1
#define LTEIOT19_POWER_STATE_RESET                      2
#define LTEIOT19_POWER_STATE_WAKEUP                     3

#define LTEIOT19_TX_DRV_BUFFER_SIZE                     256
#define LTEIOT19_RX_DRV_BUFFER_SIZE                     256
 // lteiot19_cmd



#define LTEIOT19_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.wup = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
 // lteiot19_map // lteiot19

typedef struct
{
    // Output pins
    digital_out_t wup;              
    digital_out_t rst;              
    digital_out_t rts;              
 
    // Input pins
    digital_in_t ring;              
    digital_in_t cts;               
 
    // Modules
    uart_t uart;                    
 
    // Buffers
    uint8_t uart_rx_buffer[ LTEIOT19_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ LTEIOT19_TX_DRV_BUFFER_SIZE ];  
    uint8_t cmd_buffer[ LTEIOT19_TX_DRV_BUFFER_SIZE ];      
 
} lteiot19_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
 
    // Additional gpio pins
    pin_name_t wup;                 
    pin_name_t rst;                 
    pin_name_t rts;                 
    pin_name_t ring;                
    pin_name_t cts;                 
 
    // Static variable
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
 
} lteiot19_cfg_t;

typedef enum
{
    LTEIOT19_OK = 0,
    LTEIOT19_ERROR = -1,
    LTEIOT19_ERROR_TIMEOUT = -2,
    LTEIOT19_ERROR_CMD = -3
 
} lteiot19_return_value_t;


void lteiot19_cfg_setup ( lteiot19_cfg_t *cfg );

err_t lteiot19_init ( lteiot19_t *ctx, lteiot19_cfg_t *cfg );

err_t lteiot19_generic_write ( lteiot19_t *ctx, uint8_t *data_in, uint16_t len );

err_t lteiot19_generic_read ( lteiot19_t *ctx, uint8_t *data_out, uint16_t len );

void lteiot19_set_wup_pin ( lteiot19_t *ctx, uint8_t state );

void lteiot19_set_rst_pin ( lteiot19_t *ctx, uint8_t state );

void lteiot19_set_rts_pin ( lteiot19_t *ctx, uint8_t state );

uint8_t lteiot19_get_ring_pin ( lteiot19_t *ctx );

uint8_t lteiot19_get_rts_pin ( lteiot19_t *ctx );

void lteiot19_set_power_state ( lteiot19_t *ctx, uint8_t state );

void lteiot19_cmd_run ( lteiot19_t *ctx, uint8_t *cmd );

void lteiot19_cmd_set ( lteiot19_t *ctx, uint8_t *cmd, uint8_t *value );

void lteiot19_cmd_get ( lteiot19_t *ctx, uint8_t *cmd );

void lteiot19_cmd_help ( lteiot19_t *ctx, uint8_t *cmd );

void lteiot19_set_sim_apn ( lteiot19_t *ctx, uint8_t *sim_apn );

void lteiot19_send_sms_text ( lteiot19_t *ctx, uint8_t *phone_number, uint8_t *sms_text );

err_t lteiot19_send_sms_pdu ( lteiot19_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
 
#ifdef __cplusplus
}
#endif
#endif // LTEIOT19_H
 // lteiot19
 
// ------------------------------------------------------------------------ END